/*
 * This file is part of gtkD.
 *
 * gtkD is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version, with
 * some exceptions, please read the COPYING file.
 *
 * gtkD is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with gtkD; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 */

// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage


module sourceview.LanguageManager;

private import glib.ConstructionException;
private import glib.Str;
private import glib.c.functions;
private import gobject.ObjectG;
private import sourceview.Language;
private import sourceview.c.functions;
public  import sourceview.c.types;


/**
 * Provides access to [class@Language]s.
 * 
 * `GtkSourceLanguageManager` is an object which processes language description
 * files and creates and stores [class@Language] objects, and provides API to
 * access them.
 * 
 * Use [func@LanguageManager.get_default] to retrieve the default
 * instance of `GtkSourceLanguageManager`, and
 * [method@LanguageManager.guess_language] to get a [class@Language] for
 * given file name and content type.
 */
public class LanguageManager : ObjectG
{
	/** the main Gtk struct */
	protected GtkSourceLanguageManager* gtkSourceLanguageManager;

	/** Get the main Gtk struct */
	public GtkSourceLanguageManager* getLanguageManagerStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return gtkSourceLanguageManager;
	}

	/** the main Gtk struct as a void* */
	protected override void* getStruct()
	{
		return cast(void*)gtkSourceLanguageManager;
	}

	/**
	 * Sets our main struct and passes it to the parent class.
	 */
	public this (GtkSourceLanguageManager* gtkSourceLanguageManager, bool ownedRef = false)
	{
		this.gtkSourceLanguageManager = gtkSourceLanguageManager;
		super(cast(GObject*)gtkSourceLanguageManager, ownedRef);
	}


	/** */
	public static GType getType()
	{
		return gtk_source_language_manager_get_type();
	}

	/**
	 * Creates a new language manager.
	 *
	 * If you do not need more than one language manager or a private language manager
	 * instance then use [func@LanguageManager.get_default] instead.
	 *
	 * Returns: a new #GtkSourceLanguageManager.
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this()
	{
		auto __p = gtk_source_language_manager_new();

		if(__p is null)
		{
			throw new ConstructionException("null returned by new");
		}

		this(cast(GtkSourceLanguageManager*) __p, true);
	}

	/**
	 * Returns the default #GtkSourceLanguageManager instance.
	 *
	 * Returns: a #GtkSourceLanguageManager.
	 *     Return value is owned by GtkSourceView library and must not be unref'ed.
	 */
	public static LanguageManager getDefault()
	{
		auto __p = gtk_source_language_manager_get_default();

		if(__p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(LanguageManager)(cast(GtkSourceLanguageManager*) __p);
	}

	/**
	 * Appends @path to the list of directories where the @manager looks for
	 * language files.
	 *
	 * See [method@LanguageManager.set_search_path] for details.
	 *
	 * Params:
	 *     path = a directory or a filename.
	 *
	 * Since: 5.4
	 */
	public void appendSearchPath(string path)
	{
		gtk_source_language_manager_append_search_path(gtkSourceLanguageManager, Str.toStringz(path));
	}

	/**
	 * Gets the [class@Language] identified by the given @id in the language
	 * manager.
	 *
	 * Params:
	 *     id = a language id.
	 *
	 * Returns: a #GtkSourceLanguage, or %NULL
	 *     if there is no language identified by the given @id. Return value is
	 *     owned by @lm and should not be freed.
	 */
	public Language getLanguage(string id)
	{
		auto __p = gtk_source_language_manager_get_language(gtkSourceLanguageManager, Str.toStringz(id));

		if(__p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(Language)(cast(GtkSourceLanguage*) __p);
	}

	/**
	 * Returns the ids of the available languages.
	 *
	 * Returns: a %NULL-terminated array of strings containing the ids of the available
	 *     languages or %NULL if no language is available.
	 *     The array is sorted alphabetically according to the language name.
	 *     The array is owned by @lm and must not be modified.
	 */
	public string[] getLanguageIds()
	{
		return Str.toStringArray(gtk_source_language_manager_get_language_ids(gtkSourceLanguageManager));
	}

	/**
	 * Gets the list directories where @lm looks for language files.
	 *
	 * Returns: %NULL-terminated array
	 *     containing a list of language files directories.
	 *     The array is owned by @lm and must not be modified.
	 */
	public string[] getSearchPath()
	{
		return Str.toStringArray(gtk_source_language_manager_get_search_path(gtkSourceLanguageManager));
	}

	/**
	 * Picks a [class@Language] for given file name and content type,
	 * according to the information in lang files.
	 *
	 * Either @filename or @content_type may be %NULL. This function can be used as follows:
	 *
	 * ```c
	 * GtkSourceLanguage *lang;
	 * GtkSourceLanguageManager *manager;
	 * lm = gtk_source_language_manager_get_default ();
	 * lang = gtk_source_language_manager_guess_language (manager, filename, NULL);
	 * gtk_source_buffer_set_language (buffer, lang);
	 * ```
	 *
	 * or
	 *
	 * ```c
	 * GtkSourceLanguage *lang = NULL;
	 * GtkSourceLanguageManager *manager;
	 * gboolean result_uncertain;
	 * gchar *content_type;
	 *
	 * content_type = g_content_type_guess (filename, NULL, 0, &result_uncertain);
	 * if (result_uncertain)
	 * {
	 * g_free (content_type);
	 * content_type = NULL;
	 * }
	 *
	 * manager = gtk_source_language_manager_get_default ();
	 * lang = gtk_source_language_manager_guess_language (manager, filename, content_type);
	 * gtk_source_buffer_set_language (buffer, lang);
	 *
	 * g_free (content_type);
	 * ```
	 *
	 * etc. Use [method@Language.get_mime_types] and [method@Language.get_globs]
	 * if you need full control over file -> language mapping.
	 *
	 * Params:
	 *     filename = a filename in Glib filename encoding, or %NULL.
	 *     contentType = a content type (as in GIO API), or %NULL.
	 *
	 * Returns: a #GtkSourceLanguage, or %NULL if there
	 *     is no suitable language for given @filename and/or @content_type. Return
	 *     value is owned by @lm and should not be freed.
	 */
	public Language guessLanguage(string filename, string contentType)
	{
		auto __p = gtk_source_language_manager_guess_language(gtkSourceLanguageManager, Str.toStringz(filename), Str.toStringz(contentType));

		if(__p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(Language)(cast(GtkSourceLanguage*) __p);
	}

	/**
	 * Prepends @path to the list of directories where the @manager looks
	 * for language files.
	 *
	 * See [method@LanguageManager.set_search_path] for details.
	 *
	 * Params:
	 *     path = a directory or a filename.
	 *
	 * Since: 5.4
	 */
	public void prependSearchPath(string path)
	{
		gtk_source_language_manager_prepend_search_path(gtkSourceLanguageManager, Str.toStringz(path));
	}

	/**
	 * Sets the list of directories where the @lm looks for
	 * language files.
	 *
	 * If @dirs is %NULL, the search path is reset to default.
	 *
	 * At the moment this function can be called only before the
	 * language files are loaded for the first time. In practice
	 * to set a custom search path for a `GtkSourceLanguageManager`,
	 * you have to call this function right after creating it.
	 *
	 * Since GtkSourceView 5.4 this function will allow you to provide
	 * paths in the form of "resource:///" URIs to embedded `GResource`s.
	 * They must contain the path of a directory within the `GResource`.
	 *
	 * Params:
	 *     dirs = a %NULL-terminated array of
	 *         strings or %NULL.
	 */
	public void setSearchPath(string[] dirs)
	{
		gtk_source_language_manager_set_search_path(gtkSourceLanguageManager, Str.toStringzArray(dirs));
	}
}